← Tilbage til Hovedside

Overblik

Dette afsnit beskriver det tilgængelige REST-endpoint til hentning af personbogsoplysninger.

Ved hjælp af et UUID opnået fra en tidligere søgning returnerer denne service summariske oplysninger for personer/virksomheder i personbogen. Svarformatet kan styres via valgfrie query parametre, der understøtter OIO XML, XHTML og TMV XHTML formater.

Endpoints

PersonSummarisk

Endpoint URL: personbog/{uuid}

Method

GET

Beskrivelse

Hent summariske oplysninger for en person/virksomhed i personbogen ved hjælp af deres UUID.

Input

Path parameter:

  • uuid

Valgfrie query parametre:

  • xhtml=true - returnerer svaret som XHTML

  • tmvXhtml=true - returnerer svaret som TMV XHTML med modificeret titel

  • Hvis ingen angives, returneres som OIO XML (standard)

Output

Personbogsdata i det ønskede format (OIO XML, XHTML eller TMV XHTML).

Formateringen af XHTML- og TMV XHTML-svar er ikke dokumenteret i detaljer og kan ændres uden varsel.

Fejlhåndtering

Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /personbog/99e5272d-396b-4e38-b033-5ea9098f456a?xhtml=false&tmvxhtml=false HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

SoegPersonbog

Endpoint URL: soegpersonbog

Method

GET

Beskrivelse

Søg efter personer/virksomheder i personbogen ved hjælp af navn og CPR-nummer.

Input

Query parametre:

  • navn - Navn (påkrævet)

  • cpr - CPR-nummer (påkrævet)

  • cvr - CVR-nummer (valgfri)

  • nodoks - Boolean flag for at tillade resultater uden dokumenter (valgfri)

Output

JSON-svar indeholdende matchende personer/virksomheder med grundlæggende oplysninger (inkl. uuid).

Fejlhåndtering

  • 429 Too Many Requests - hvis anmodningsgrænsen overskrides

  • Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /soegpersonbog/99e5272d-396b-4e38-b033-5ea9098f456a?navn=John%20Doe&cpr=1234567890&cvr=&nodoks=false HTTP/1.1

SoegPersonbogCvr

Endpoint URL: soegpersonbogcvr

Method

GET

Beskrivelse

Søg efter personer/virksomheder i personbogen ved hjælp af CVR-nummer eller navn med/uden fødselsdato.

Input

Query parametre (gensidigt udelukkende kombinationer):

  • cvr alene - Søg på CVR-nummer

  • navn + fdato - Søg på navn og fødselsdato

  • navn + udenfdato=true - Søg på navn uden fødselsdato

Output

JSON-svar indeholdende matchende personer/virksomheder med grundlæggende oplysninger (inkl. uuid).

Fejlhåndtering

  • Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /soegpersonbogcvr/99e5272d-396b-4e38-b033-5ea9098f456a?cvr=15231599&navn=John%20Doe&fdato=01.01.1970&udenfdato=false HTTP/1.1